ValuesScreen

ValuesScreen business rule is configured at the plan level.  This rule is used with the PolicyValues business rule to display the policy's values on the Values screen (invoked by clicking the Values link on the Policy screen).  PolicyValues business rule must be configured prior to configuring the ValuesScreen business rule.

 

ValuesScreen business rule dictates how to display (format) the item/variable (such as currency, text, etc.) on the Values screen whereas the PolicyValues business rule specifies the math variables that are to be calculated and displayed on the Values screen.

 

In addition, the ValuesScreen business rule can also perform the following:

ValuesScreen Element/Attribute Table

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<ValuesScreen>

The opening and closing tag of the business rule.

 

 

   <PolicyDetails>

 

 

 

    <PolicyValues>

Required element;

This tag is used to control the display of policy values in the PolicyValue section of the Values screen.

 

 

     <Fields>

Required element;

This tag is used to configure the properties of the fields that should be displayed in the Policy Values section.

 

 

         <Field>

Defines the description and display of the fields in the Policy Values section of the screen.

 

Required Element Value;

MathVariable / Policy_FieldName / Blank

 

MathVariable: To retrieve the mathvariable values defined in the PolicyValues business rule.

Policy_FieldName: To retrieve the values from the PolicyScreen fields. (i.e.,  Policy_PolicyNumber).

Blank: To display blank space.

      <FundDetails>

Required element;

Fund details are displayed within a table in the fund section of the Values screen. This tag is used to configure the properties with which these fund details should be displayed in various columns.

 

Note:  By default, Fund Name and Cash Value columns are always displayed in the Fund Details section.

BREAKOUTFORCHILD

Optional attribute;

This attribute is used to indicate whether or not the Fund Details table should have an option to expand a parent fund to show the cash value distributions in each of the children, as of the specified effective date

Yes / No

Yes: To display the Parent fund with an Expand ( '+') sign, clicking which expands and displays the Child funds with the respective Cash Values

No: To display the CashValue distributions for each of the Children funds participating in the Policy

 

Note:  When the money is invested on a active Child fund they will use their Unit Values to calculate the value of that piece of money for their lifetime.

     <Exclude>

Optional element;

To exclude the funds (in which the policy has invested money) from being displayed in the Fund Details section of the Values screen.

 

 

         <Fund>

Required/Repeatable element;

Name of fund to be excluded from displaying in the Fund Details table.

 

Required Element value;

FundName

Name of the fund that needs to be excluded.

     <Columns>

Optional element;

Defines the columns that will be displayed within the table in the Fund Details section.

 

 

         <Units>

Optional element;

Defines the description of the column "Units" for a particular fund.  Units is defined as the number of Units owned for an investment on the fund.

TITLE

Optional attribute;

To define the display name of the Columns within the Fund details table.

        <UnitValue>

Optional element;

Defines the description of the column "UnitValue" for a particular fund.  Displays the unit value price of each unit.

TITLE

 

 

 

 

 

 

FORMAT

Optional attribute;

="String"

To define the display name of the Columns within the Fund details table

 

 

Optional attribute;

="CURRENCY"

To define the formatting of the UnitValue column values in the ValuesScreen

CURRENCY: Formats the policy value to CURRENCY.

     <Graphs>

Optional element;

To configure the display of pie charts for assets and allocations.

ASSETS

Optional attribute;

Yes / No

Yes: Displays the pie chart for Assets.

No: When set to "No" pie chart for Assets will not be displayed.

If this attribute is not present pie chart for Assets will not be displayed.

ALLOCATIONS

Optional attribute;

Yes / No

Yes: Displays the pie chart for Allocations

No: Pie chart for allocations will not be displayed.  If this attribute is not present pie chart for allocations will not be displayed.

 

XML Example

<ValuesScreen>

  <PolicyDetails></PolicyDetails>  

  <PolicyValues>

   <Fields>

    <Field>

     <Name>PolicyCashValue</Name>

     <Display>Policy Cash Value</Display>

     <DataType>Money</DataType>

     <Disabled>Yes</Disabled>

    </Field>

    </PolicyValues>

  <FundDetails>

   <Exclude>

    <Fund>GMDB Rollup</Fund>

    <Fund>GMIB</Fund>

    <Fund>GMWB</Fund>

   </Exclude>

   <Columns>

    <Column WIDTH="100" ALIGN="RIGHT">

     <Name>Principal</Name>

     <Display>Principal</Display>

     <DataType>Money</DataType>

    </Column>

    <Column WIDTH="100" ALIGN="RIGHT">

     <Name>Gain</Name>

     <Display>Gain</Display>

     <DataType>Money</DataType>

     </Column>

   </Columns>

  </FundDetails>

  <Graphs ALLOCATIONS="No" ASSETS="Yes"/>

 </ValuesScreen>